Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

oracle.AWXML
Class DimensionMapGroup

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.MappingGroup
              |
              +--oracle.AWXML.DimensionMapGroup

public class DimensionMapGroup
extends MappingGroup

A MappingGroup that specifies data source mapping expressions for a Dimension. The mapping expressions specify the relational columns that contain dimension members and attributes.

A DimensionMapGroup can be owned by a Dimension, a Hierarchy, a Level, or a HierarchyLevelAssociation. The DimensionMapGroup can specify mapping expressions for some or all of the dimension members or attributes.

Use the oracle.AWAction.BuildDatabase class to load data from the mapped data sources into analytic workspace Dimension and Attribute objects.

See Also:
CubeMapGroup, BuildDatabase

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

 

Constructor Summary
DimensionMapGroup(BaseObject input)
          Creates a DimensionMapGroup for the specified Dimension, Hierarchy, Level, or HierarchyLevelAssociation.

 

Method Summary
 void addAttributeMap(AttributeSourceExpression input)
          Adds the specified AttributeSourceExpression to the DimensionMapGroup.
 void addAttributeSourceExpression(AttributeSourceExpression input)
          Adds the specified AttributeSourceExpression to the DimensionMapGroup.
 java.lang.String Create(AWConnection connection)
          Creates the DimensionMapGroup in the current analytic workspace of the specified database connection.
 AttributeSourceExpression CreateAttributeMap()
          Creates an AttributeSourceExpression for the DimensionMapGroup.
 AttributeSourceExpression CreateAttributeMap(java.lang.String lang)
          Creates an AttributeSourceExpression with the specified language for the DimensionMapGroup.
 DimensionKeySourceExpression CreateKeyMap()
          Creates a DimensionKeySourceExpression for the DimensionMapGroup.
 HierarchicalParentSourceExpression CreateParentMap()
          Creates a HierarchicalParentSourceExpression for the DimensionMapGroup.
 java.util.Vector getAttributeMaps()
          Gets a list of the AttributeSourceExpression objects owned by the DimensionMapGroup.
 DimensionKeySourceExpression getKeyMap()
          Gets the DimensionKeySourceExpression owned by the DimensionMapGroup.
 HierarchicalParentSourceExpression getParentMap()
          Gets the HierarchialParentSourceExpression for the DimensionMapGroup when the DimensionMapGroup is owned by a HierarchyLevelAssociation.
 void removeAttributeMap(AttributeSourceExpression input)
          Removes the specified AttributeSourceExpression from the DimensionMapGroup.
 void setDimensionKeySourceExpression(DimensionKeySourceExpression input)
          Specifies a DimensionKeySourceExpression for the DimensionMapGroup.
 void setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)
          Specifies a HierarchialParentSourceExpression for the DimensionMapGroup.
 void setKeyMap(DimensionKeySourceExpression input)
          Specifies the DimensionKeySourceExpression for the DimensionMapGroup.
 void setParentMap(HierarchicalParentSourceExpression input)
          Specifies a HierarchialParentSourceExpression for the DimensionMapGroup.
 java.lang.String WriteToXML()
          Gets an XML representation of the DimensionMapGroup.

 

Methods inherited from class oracle.AWXML.MappingGroup
Delete

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

DimensionMapGroup

public DimensionMapGroup(BaseObject input)
Creates a DimensionMapGroup for the specified Dimension, Hierarchy, Level, or HierarchyLevelAssociation.
Parameters:
input - The Dimension, Hierarchy, Level, or HierarchyLevelAssociation to own the new DimensionMapGroup.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the DimensionMapGroup.
Overrides:
WriteToXML in class MappingGroup
Returns:
An XML String that represents the DimensionMapGroup.

getKeyMap

public DimensionKeySourceExpression getKeyMap()
Gets the DimensionKeySourceExpression owned by the DimensionMapGroup.
Returns:
The DimensionKeySourceExpression for the DimensionMapGroup.

setKeyMap

public void setKeyMap(DimensionKeySourceExpression input)
Specifies the DimensionKeySourceExpression for the DimensionMapGroup.
Parameters:
input - The DimensionKeySourceExpression that you want the DimensionMapGroup to own.

setDimensionKeySourceExpression

public void setDimensionKeySourceExpression(DimensionKeySourceExpression input)
Specifies a DimensionKeySourceExpression for the DimensionMapGroup. This method is the same as the setKeyMap method.
Parameters:
input - The DimensionKeySourceExpression that you want the DimensionMapGroup to own.

getParentMap

public HierarchicalParentSourceExpression getParentMap()
Gets the HierarchialParentSourceExpression for the DimensionMapGroup when the DimensionMapGroup is owned by a HierarchyLevelAssociation.
Returns:
The HierarchialParentSourceExpression owned by the DimensionMapGroup.

setParentMap

public void setParentMap(HierarchicalParentSourceExpression input)
Specifies a HierarchialParentSourceExpression for the DimensionMapGroup. The HierarchialParentSourceExpression maps a relational column of child values to a column of parent values in a hierarchy of a dimension. Use this method only when the DimensionMapGroup is owned by a HierarchyLevelAssociation.
Parameters:
input - The HierarchialParentSourceExpression to associate with the DimensionMapGroup.

setHierarchicalParentSourceExpression

public void setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)
Specifies a HierarchialParentSourceExpression for the DimensionMapGroup. Use this method only when the DimensionMapGroup is owned by a HierarchyLevelAssociation. This method is the same as the setParentMap method.
Parameters:
input - The HierarchialParentSourceExpression to associate with the DimensionMapGroup.

addAttributeMap

public void addAttributeMap(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup.
Parameters:
input - The AttributeSourceExpression to add.

removeAttributeMap

public void removeAttributeMap(AttributeSourceExpression input)
Removes the specified AttributeSourceExpression from the DimensionMapGroup.
Parameters:
input - The AttributeSourceExpression to remove.

addAttributeSourceExpression

public void addAttributeSourceExpression(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup. This method is the same as the addAttributeMap method.
Parameters:
input - The AttributeSourceExpression to add.

getAttributeMaps

public java.util.Vector getAttributeMaps()
Gets a list of the AttributeSourceExpression objects owned by the DimensionMapGroup.
Returns:
A Vector that contains the AttributeSourceExpression objects owned by the DimensionMapGroup.

CreateKeyMap

public DimensionKeySourceExpression CreateKeyMap()
Creates a DimensionKeySourceExpression for the DimensionMapGroup.
Returns:
The new DimensionKeySourceExpression.

CreateParentMap

public HierarchicalParentSourceExpression CreateParentMap()
Creates a HierarchicalParentSourceExpression for the DimensionMapGroup. Use this method only when the DimensionMapGroup is owned by a HierarchyLevelAssociation.
Returns:
The new HierarchicalParentSourceExpression.

CreateAttributeMap

public AttributeSourceExpression CreateAttributeMap()
Creates an AttributeSourceExpression for the DimensionMapGroup.
Returns:
The new AttributeSourceExpression.

CreateAttributeMap

public AttributeSourceExpression CreateAttributeMap(java.lang.String lang)
Creates an AttributeSourceExpression with the specified language for the DimensionMapGroup.
Parameters:
lang - A String that specifies the language for the AttributeSourceExpression.
Returns:
The new AttributeSourceExpression.

Create

public java.lang.String Create(AWConnection connection)
Creates the DimensionMapGroup in the current analytic workspace of the specified database connection.
Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains Success if the method creates the DimensionMapGroup.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

Copyright © 2003, 2005 Oracle. All rights reserved.